docs: OT-2 instruction manual revisions #19620
Conversation
Delete if the project shouldn't go forward.
Created sections to see what this could look like. - placeholder section headers - placeholder text
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## edge #19620 +/- ##
==========================================
+ Coverage 23.04% 24.67% +1.62%
==========================================
Files 3437 3445 +8
Lines 302623 304722 +2099
Branches 39867 40009 +142
==========================================
+ Hits 69746 75188 +5442
+ Misses 232854 229509 -3345
- Partials 23 25 +2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
After this, we'll stop and make a branch from the draft pr. Each chapter will be a branch.
After this, these will be separate PRs.
Moving on to other chapters
ecormany
added
the
DO NOT MERGE
There was a problem hiding this comment.
Looking pretty good so far, Joe! Left a few comments that might be in sections you haven't gotten to yet (apologies if so). Re-request review whenever more files are ready/the whole thing is ready and I'll look again.
I will say the sandbox isn't working for me (pulls up the docs site, but it doesn't include the OT-2 manual). Not sure if this is a known issue.
docs/ot-2/docs/appendicies.md
Outdated
| @@ -0,0 +1,10 @@ | |||
| --- | |||
| title: "Opentrons OT-2: Appendicies" | |||
There was a problem hiding this comment.
That shouldn't be in this branch. Removing.
| @@ -0,0 +1,14 @@ | |||
| --- | |||
| title: "Opentrons OT-2 Liquid Handler Instruction Manual" | |||
There was a problem hiding this comment.
should we just keep it "Opentrons OT-2 Instruction Manual"?
the Flex manual title doesn't include "liquid handler"
docs/ot-2/docs/installation.md
Outdated
|
|
||
| ### Requirements | ||
|
|
||
| Warning: The Opentrons Liquid Handler can emit vibration while in operation. For |
There was a problem hiding this comment.
replace "Opentrons Liquid Hander" with OT-2 throughout section?
There was a problem hiding this comment.
This file shouldn't be in here. Just look at introduction.md and regulatory.md
Need to remove a file from the nav section of the .yml file and remove link from text in an obsolete file.
Overview
Revise and migrate OT-2 instruction manual into the new documentation system. Flex instruction manual is the model.
Other changes: There should be no really new information added, unless something important is missing. This is old wine, a new bottle, and remove the sediment.
We will create separate branches from this for each chapter and merge those back into this branch after review.
Sandbox: https://sandbox.docs.opentrons.com/docs-ot2-manual-revisions/
References:
Test Plan and Hands on Testing
I can haz wordz. Plz read.
Changelog
2 new files for review:
introduction.mdregulatory.mdReview requests
If some text is familiar or seems familiar, that's because it may be. Some OT-2 sections are similar to the Flex manual. In many cases, this project will replace that older content with text from the Flex manual, and just change "Flex" to "OT-2."
Risk assessment
Low because this is documentation; medium because it is content an installed user-base relies on. Need to keep the revised manual useful for those folks.